# What is Vim-Immersive?

This is a simple vim plugin that centralizes the text on the screen. It works by
creating two splits and then hiding the window decorations. It is in an early
stage, so it only works well when there is only one window open. Since I only
use the plugin when writing or inspecting a single file, it will take a while
for me to add new features (if I add them at all), but feel free to open
requests.

Also, the plugin makes use of vim9script which is incompatible with neovim. It
should be trivial, though, to convert it to classic vimscript and make it more
portable. Why I didn't do that on the first place? I currently don't use neovim
(but plan on giving it try) and wished to learn to use vim9script. One day,
perhaps, I shall make the rewrite.

# Installation

First, clone or download this repository.

```text
git clone 'https://notabug.org/paone/vim-immersive.git'
```
Then copy the plugin files to your ~/.vim.

```text
cp vim-immersive/autoload/immersive.vim ~/.vim/autoload
cp vim-immersive/plugin/immersive.vim ~/.vim/plugin
```

# Usage

The plugin creates a new command called Immersive. To call it, merely type
:Immersive in normal mode and press enter. Calling it again will toggle the
window back to it's previous state. You can also map the Immersive command as
you would any other.
